Skip to content

fix: update release notes generation rules for clarity and formatting#351

Merged
frontegg-david merged 1 commit intomainfrom
fix-release-notes
Apr 9, 2026
Merged

fix: update release notes generation rules for clarity and formatting#351
frontegg-david merged 1 commit intomainfrom
fix-release-notes

Conversation

@frontegg-david
Copy link
Copy Markdown
Contributor

@frontegg-david frontegg-david commented Apr 9, 2026

Summary by CodeRabbit

  • Chores
    • Enhanced release notes formatting and generation process to improve consistency and clarity across future releases.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 9, 2026

📝 Walkthrough

Walkthrough

The pull request updates a GitHub Actions release workflow by modifying the OpenAI system prompt to emphasize a "benefit-focused tone" and adjusting CARD_MDX formatting requirements to include en dashes and blank-line separation. A post-processing awk step is added to ensure proper double-newline spacing between emoji bullets before embedding in the release body.

Changes

Cohort / File(s) Summary
Publish Release Workflow
.github/workflows/publish-release.yml
Updated OpenAI system prompt to shift release-notes tone from "professional marketing" to "professional, benefit-focused"; changed CARD_MDX bullet format to include en dash (–) and require blank-line separation; added awk post-processing step to insert blank lines between consecutive emoji bullets in /tmp/card-mdx.txt.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 The workflow hops along so fine,
En dashes dance in every line,
Blank spaces bloom between each mark,
Release notes gleam, no longer dark!
Awk adds magic, clear and bright,

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating release notes generation rules for clarity and formatting in the GitHub workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-release-notes

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.github/workflows/publish-release.yml (1)

471-479: Make CARD_MDX bullet detection structure-based, not emoji allow-list based.

Line [473] hard-codes emoji values. If the model outputs a valid but unlisted emoji, spacing normalization won’t run for that bullet.

Proposed diff
-            awk '
-              /^[[:space:]]*(🔌|🔄|📋|⚡|💾|🔐|🎨|☁️|🌐|📦|🔧|🪝|🔑|🚀|🛡️|✨|🔍|🧩|🔒|🔥|🎯|⚙️|📝)/ {
+            awk '
+              /^[[:space:]]*[^[:space:]]+[[:space:]]+\*\*[^*]+\*\*[[:space:]]+[-–—][[:space:]]+/ {
                 if (prev_was_bullet) print ""
                 prev_was_bullet = 1
                 print; next
               }
               { prev_was_bullet = 0; print }
             ' /tmp/card-mdx.txt > /tmp/card-mdx-fixed.txt && mv /tmp/card-mdx-fixed.txt /tmp/card-mdx.txt
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/publish-release.yml around lines 471 - 479, The current
awk block uses a hard-coded emoji allow-list to detect bullet lines (the regex
in the awk script and prev_was_bullet logic operating on /tmp/card-mdx.txt), so
unlisted emojis won’t get double-newline normalization; change the detection to
a structure-based regex that matches any leading emoji/unicode pictograph (e.g.,
use a Unicode property like \p{Extended_Pictographic} or a broad emoji character
class) instead of the explicit list, keep the prev_was_bullet flag and the same
print/empty-line insertion logic, and write the transformed output to
/tmp/card-mdx-fixed.txt as before then mv back to /tmp/card-mdx.txt.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/publish-release.yml:
- Around line 471-479: The current awk block uses a hard-coded emoji allow-list
to detect bullet lines (the regex in the awk script and prev_was_bullet logic
operating on /tmp/card-mdx.txt), so unlisted emojis won’t get double-newline
normalization; change the detection to a structure-based regex that matches any
leading emoji/unicode pictograph (e.g., use a Unicode property like
\p{Extended_Pictographic} or a broad emoji character class) instead of the
explicit list, keep the prev_was_bullet flag and the same print/empty-line
insertion logic, and write the transformed output to /tmp/card-mdx-fixed.txt as
before then mv back to /tmp/card-mdx.txt.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5fffbee1-f3fe-436e-995a-e095da2a8b0c

📥 Commits

Reviewing files that changed from the base of the PR and between baf63eb and dd1c078.

📒 Files selected for processing (1)
  • .github/workflows/publish-release.yml

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

Performance Test Results

Status: ✅ All tests passed

Summary

Project Tests Passed Warnings Failed Leaks
✅ demo-e2e-agents 4 4 0 0 0
✅ demo-e2e-cache 11 11 0 0 0
✅ demo-e2e-codecall 4 4 0 0 0
✅ demo-e2e-config 4 4 0 0 0
✅ demo-e2e-direct 3 3 0 0 0
✅ demo-e2e-elicitation 1 1 0 0 0
✅ demo-e2e-errors 4 4 0 0 0
✅ demo-e2e-hooks 3 3 0 0 0
✅ demo-e2e-multiapp 4 4 0 0 0
✅ demo-e2e-notifications 3 3 0 0 0
✅ demo-e2e-openapi 2 2 0 0 0
✅ demo-e2e-providers 4 4 0 0 0
✅ demo-e2e-public 4 4 0 0 0
✅ demo-e2e-redis 15 15 0 0 0
✅ demo-e2e-remember 4 4 0 0 0
✅ demo-e2e-remote 5 5 0 0 0
✅ demo-e2e-serverless 2 2 0 0 0
✅ demo-e2e-skills 15 15 0 0 0
✅ demo-e2e-standalone 2 2 0 0 0
✅ demo-e2e-transport-recreation 3 3 0 0 0
✅ demo-e2e-ui 4 4 0 0 0

Total: 101 tests across 21 projects

📊 View full report in workflow run


Generated at: 2026-04-09T05:12:36.602Z
Commit: b51b2efa

@frontegg-david frontegg-david merged commit 1cf770f into main Apr 9, 2026
30 checks passed
@frontegg-david frontegg-david deleted the fix-release-notes branch April 9, 2026 05:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant